Skip to content

docs(readme.md): changes to contributor images in the community #1036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

soamn
Copy link

@soamn soamn commented Sep 8, 2024

 section

Summary of change

In Readme section instead of using tables used contrib.rocks to create cleaner Contributor Images which links you to the Contributor section

Documentation changes

(If relevant, please create a PR in our docs repo, or create a checklist here
highlighting the necessary changes)

Remaining TODOs for this PR

  • Can change the query params to increase or decrease the row numbers (default is 12)
  • Can change the anon =1 param to hide anonymous users.

@rishabhpoddar
Copy link
Contributor

Hi,

This is cool, however, we also add profiles of contributors who have contributed to one of our other sdks (like the supertokens-node one). Do you think there is a way to combine the contributors across all of our repos and show that in here?

Comment on lines +155 to +157
<a href="https://github.com/supertokens/supertokens-core/graphs/contributors">
<img src="https://contrib.rocks/image?repo=supertokens/supertokens-core&columns=9&anon=1" style="padding:10px" />
</a>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The heading "Contributors (across all SuperTokens repositories)" indicates a comprehensive list of contributors from all repositories, but the new implementation only displays contributors from the supertokens-core repository. This creates a mismatch between what's promised and what's delivered.

Consider either:

  1. Updating the heading to accurately reflect the content (e.g., "Contributors to supertokens-core")
  2. Modifying the implementation to include contributors from all SuperTokens repositories

This change will ensure consistency between the section heading and the actual content displayed.

Suggested change
<a href="https://github.com/supertokens/supertokens-core/graphs/contributors">
<img src="https://contrib.rocks/image?repo=supertokens/supertokens-core&columns=9&anon=1" style="padding:10px" />
</a>
+<a href="https://github.com/supertokens">
+ <img src="https://contrib.rocks/image?org=supertokens&columns=9&anon=1" style="padding:10px" />
+</a>

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants